package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.SiteContractQuotaAddDTO;
import org.jsola.hr.dto.SiteContractQuotaUpdateDTO;
import org.jsola.hr.query.SiteContractQuotaQuery;
import org.jsola.hr.vo.SiteContractQuotaVO;

import java.util.List;

/**
 * 租户合同配额表
 *
 * @author wcl
 */
@Api(tags = "hr-租户合同配额表")
public interface ISiteContractQuotaControllerAPI {

    /**
     * 新增租户合同配额
     *
     * @param siteContractQuotaAddDTO 租户合同配额新增实体
     * @return 租户合同配额展示对象
     */
    @ApiOperation(value = "新增租户合同配额")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "siteContractQuotaAddDTO", dataType = "SiteContractQuotaAddDTO", value = "新增租户合同配额", paramType = "body")
    })
    Result<SiteContractQuotaVO> save(SiteContractQuotaAddDTO siteContractQuotaAddDTO);


    /**
     * 修改租户合同配额
     *
     * @param siteContractQuotaUpdateDTO 租户合同配额
     * @return 更新数量
     */
    @ApiOperation(value = "修改租户合同配额")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "siteContractQuotaUpdateDTO", dataType = "SiteContractQuotaUpdateDTO", value = "修改租户合同配额", paramType = "body")
    })
    Result<Integer> update(SiteContractQuotaUpdateDTO siteContractQuotaUpdateDTO);

    /**
     * 删除单个租户合同配额，彻底删除
     *
     * @param siteContractQuotaId 租户合同配额id
     * @return 删除数量
     */
    @ApiOperation(value = "删除单个租户合同配额，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "siteContractQuotaId", dataType = "String", value = "租户合同配额id", paramType = "path")
    })
    Result<Integer> delete(String siteContractQuotaId);


    /**
     * 批量删除租户合同配额，彻底删除
     *
     * @param siteContractQuotaIds 租户合同配额id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除租户合同配额，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "siteContractQuotaIds", dataType = "String[]", value = "租户合同配额id数组", paramType = "body", allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] siteContractQuotaIds);


    /**
     * 根据租户合同配额id查询租户合同配额详情
     *
     * @param siteContractQuotaId 租户合同配额id
     * @return 租户合同配额详情
     */
    @ApiOperation(value = "根据租户合同配额id查询租户合同配额详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "siteContractQuotaId", dataType = "String", value = "租户合同配额id", paramType = "path")
    })
    Result<SiteContractQuotaVO> findById(String siteContractQuotaId);


    /**
     * 查询租户合同配额
     *
     * @param siteContractQuotaQuery 租户合同配额查询参数
     * @return page
     */
    @ApiOperation(value = "查询租户合同配额")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "siteContractQuotaQuery", dataType = "SiteContractQuotaQuery", value = "租户合同配额查询参数", paramType = "query")
    })
    Result<List<SiteContractQuotaVO>> listAll(SiteContractQuotaQuery siteContractQuotaQuery);


    /**
     * 分页查询租户合同配额
     *
     * @param siteContractQuotaQuery 租户合同配额查询参数
     * @return page
     */
    @ApiOperation(value = "分页查询租户合同配额")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "siteContractQuotaQuery", dataType = "SiteContractQuotaQuery", value = "租户合同配额查询参数", paramType = "query")
    })
    Result<Page<SiteContractQuotaVO>> page(SiteContractQuotaQuery siteContractQuotaQuery);


}

